BatchValidationParameters Class
Encapsulates batch job parameters including session Id, production workspace and analysis area. Use this class to define the properties of a Batch Validation Job. Use instances of this class to define parameters for functions in BatchValidationTask.
See executeJob, scheduleJob, editJob
Constructor
BatchValidationParameters
()
Item Index
Methods
Methods
_toJSONBVScheduleParameter
()
JSON Object
private
Initializes the schedule input of a batch validation job
Returns:
_toJSONBVSettingsParameter
()
JSON Object
private
Initializes the settings input of a batch validation job
Returns:
toJSONEditParameters
()
JSON Object
private
Serializes the contents of this class into a JSON object that can be used in an editJob operation.
Returns:
toJSONExecuteParameters
()
JSON Object
private
Serializes the contents of this class into a JSON object that can be used in an executeJob operation.
Returns:
toJSONScheduleParameters
()
JSON Object
private
Serializes the contents of this class into a JSON object that can be used in a scheduleJob operation.
Returns:
Properties
analysisArea
Polygon esri/geometry/Polygon
A geometry that defines the validation extent. Features that intersect this area will be validated.
Example:
var bvParams = new BatchValidationParameters();
var polygon = {"rings" : [[[1557601,6618462],[1594673,6618462],[1594673,6595378],[1557601,6595378],[1557601,6618462]]],"spatialReference" : 102100};
bvParams.analysisArea = polygon;
changedFeaturesOnly
Boolean
Controls validation type on enterprise geodatabases. If true, validation is limited to features that have changed from a parent to the child version. Changes between versions include the following:
- Features inserted in the child version but not the parent.
- Features changed in the child version and unchanged in the parent.
- Features changed in both child and parent versions.
- Features changed in the child version and deleted in the parent.
createdBy
String
Read-only
Gets the name of the web user that created the batch job schedule. Ignored by the server if set.
cronExpression
String
Gets or sets the batch validation execution schedule. This schedule is a cron expression string. Cron expressions set to execute more frequently than once every 15 minutes are not supported.
executionsEndDate
Date
Gets or sets the ending date for a batch validation schedule. Executions will not occur after this date. If both this property and executionsEndDate are set, the Batch Validation schedule will finish with whichever condition happens first.
fileItemId
String
Gets or sets the ID of the uploaded batch job. Batch validation requires a .rbj (batch job) file. You upload this file to ArcGIS for Server using the server's uploads functionality. Uploads returns an item ID. This ID is referenced during Batch Validation. See ArcGIS for Server REST API documentation for more information on uploads.
maxNumberOfExecutions
Number
Gets or sets the maximum number of batch validation executions that can run.
If both this property and executionEndDate are set, the Batch Validation schedule will finish with whichever condition happens first.
productionWorkspace
String
Gets or sets the production workspace path. This path must be accessible to ArcGIS for Server.
sessionString
String
Gets or sets the ArcGIS Data Reviewer session. The session must exist in the reviewer workspace.
The session string must follow this format: "Session [Session ID] : [Session Name]", e.g. "Session 1 : Editing Session".
See ReviewerSession
userName
String
Gets or sets the user name under which records are written to the reviewer workspace.